Skip to main content

Plugin Settings

You can manage overall plugin settings in Project Settings → Plugins → LayeredTooltip Settings.

Essential Settings for Basic Use​

Tooltip Display Delay

  • Default: 0.1 seconds
  • Purpose: Time for tooltip to appear on mouse hover

Tooltip Position Offset

  • Default: (4, 4)
  • Purpose: Distance from mouse cursor to tooltip

Advanced Settings for Customization​

Layered Tooltip Widget Class

  • Default: Plugin default widget
  • Requirements: Must implement ILayeredTooltipWidget interface

Tooltip Text Provider Class

  • Default: Uses string table
  • Requirements: Must implement ILayeredTooltipTextProvider interface

Default Tooltip Text String Table

  • Default: Plugin default string table

Settings for Advanced Users​

Tooltip Tags

  • Default: ["Tooltip"]
  • Purpose: Add tag names for use in rich text
  • Example: ["tooltip", "help", "item"] → Enables <tooltip>, <help>, <item> tags

Tooltip Pin Delay

  • Default: 1.0 seconds
  • Purpose: Time until tooltip becomes pinned and clickable
  • Adjustment: Longer prevents accidental pinning; shorter enables quick interaction

Close Pinned On Cursor Leave

  • Default: false
  • Purpose: When enabled, a pinned tooltip closes automatically once the cursor leaves the tooltip area (the trigger item, its tooltip, and any child tooltips), instead of waiting for a click on empty space.
  • Behavior: Only the layers the cursor has left are closed; outer layers stay open so you can keep navigating other child tooltips.

Pin Area Close Margin

  • Default: 40 (viewport pixels)
  • Purpose: Extra margin added around the tooltip/trigger area before a pinned tooltip auto-closes. Larger values keep the tooltip open further past the edge, preventing flicker.
  • Note: Only used when Close Pinned On Cursor Leave is enabled.

Tooltip Default Z Order

  • Default: 1000
  • When to Adjust: Set higher value when tooltip is hidden behind other UI elements

Debug Settings​

Layered Tooltip Debug

  • Default: false
  • When Enabled: Shows tooltip trigger areas and outputs detailed logs
  • Purpose: Diagnose issues when tooltips don't work

Important Notes​

  • Editor restart may be required when changing widget/text provider classes.